Motion.MoveSpline method

Moves an axis group along a spline curve.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus MoveSpline(
       int Index,
       int SplineId,
       McCoordSystem CoordSystem,
       McBufferMode BufferMode,
       McTransitionMode TransitionMode,
       double[] TransitionParameter,
       double Time
)

Public Function MoveSpline(
       Index As Integer,
       SplineId As Integer,
       CoordSystem As McCoordSystem,
       BufferMode As McBufferMode,
       TransitionMode As McTransitionMode,
       TransitionParameter As Double(),
       Time As Double
) As KsCommandStatus

Parameters

Index

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

SplineId

Type: int

The index of a curve.

CoordSystem

Type: McCoordSystem

A coordinate system.

BufferMode

Type: McBufferMode

Defines the chronological sequence of the function.

TransitionMode

Type: McTransitionMode

Inserts a transition curve.

TransitionParameter

Type: double[]

The additional parameter for the transition mode. If TransitionMode is set to mcNone, this parameter has no effect.

Time

Type: double

Reserved.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

If the current group command position is different from the starting point of a spline, MoveSpline will move the group to that starting point with a point-to-point move and start the spline motion afterwards.

Examples

N/A